Operation NuxeoDrive.Delete (Nuxeo Drive: Delete)

In component org.nuxeo.drive.operations.NuxeoDriveGetRootsOperation

Description

Delete the document backing the file system item with the given id.

Operation id	NuxeoDrive.Delete
Category	Services
Label	Nuxeo Drive: Delete
Requires
Since

Parameters

Name	Description	Type	Required	Default value
id	Id of the file system item backed by the document to delete.	string	yes
parentId	Optional id of the file system item backed by the parent container of the document to delete. For optimization purpose.	string	no

Signature

Inputs	void
Outputs	void

Implementation Information

Implementation Class	Class: org.nuxeo.drive.operations.NuxeoDriveDelete
Contributing Component	org.nuxeo.drive.operations.NuxeoDriveGetRootsOperation

JSON Definition

{
  "id" : "NuxeoDrive.Delete",
  "label" : "Nuxeo Drive: Delete",
  "category" : "Services",
  "requires" : null,
  "description" : "Delete the document backing the file system item with the given id.",
  "url" : "NuxeoDrive.Delete",
  "signature" : [ "void", "void" ],
  "params" : [ {
    "name" : "id",
    "description" : "Id of the file system item backed by the document to delete.",
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "parentId",
    "description" : "Optional id of the file system item backed by the parent container of the document to delete. For optimization purpose.",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}